Release 10.1A: OpenEdge Development:
ADM and SmartObjects

Custom ADM Class Files

Each ADM class also is supported by a set of custom class files of specific types: a primary include file, a property file, a super procedure, a prototype file, an exclude definition file, and an instance definition file. These files can provide the basis for developing custom SmartObjects and/or classes based on existing SmartObjects and classes. As with the standard class files, each ADM class contains one file of each type. Custom ADM class files reside in the custom subdirectory of the %DLC%\src\adm2 (Windows) or $DLC/src/adm2 (UNIX) directory.

Table 1–2 describes the custom class files for each class. As in Table 1–1, type in the Filename column is a character string indicating the particular class; for example, view or viewer for the viewer class.

Table 1–2: Custom ADM class files 

File type	Filename	Description
Custom primary include file	typecustom.i	Starts the custom super procedure for the class (commented out in the standard primary include file). Can initialize some properties.
Custom property file	typepropcustom.i	Defines properties. References the custom prototype file.
Custom super procedure file	typecustom.p	Contains functions and internal procedures that define additional behavior for the class. References the property file. Is run only once for the entire session.
Custom prototype file	typeprtocustom.i	References all internal entries (functions, internal procedures) of the super procedure for the class.
Custom exclude definition file	typeexclcustom.i	Defines EXCLUDE-type preprocessor variables that exclude functions or internal procedures from the super procedure for the class.
Custom instance definition file	typedefscustom.i	References definitions for instance properties. References the definition of the instance property dialog box.

For example, the following custom class files support the viewer class:

Custom primary include file: viewercustom.i
Custom property file: viewpropcustom.i
Custom super procedure: viewercustom.p
Custom prototype file: viewprtocustom.i
Custom exclude definition file: viewerexclcustom.i
Custom instance definition file: viewerdefscustom.i

For examples of the contents of custom class files, see Appendix A "ADM Standard and Custom Class Files." For information on using custom class files to extend the ADM, see Chapter 8, " Developing ADM Extensions."